home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / hnr110.zip / HNR.DOC < prev    next >
Text File  |  1992-01-27  |  23KB  |  489 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                            
  8.                                            
  9.                                            
  10.                                            
  11.                                            
  12.                                            
  13.                                            
  14.                                            
  15.                             Headline NewsRoom Version 1.10
  16.  
  17.                                 News File Generator for
  18.                                  BBS  System Operators
  19.      
  20.                                            
  21.                                      User Manual
  22.                                            
  23.                                            
  24.                                            
  25.                                            
  26.                                            
  27.                          Copyrighted (C) Oakwood Software 1992
  28.                                      by Scott Null
  29.                                            
  30.                                            
  31.                  Find this and other Oakwood Software products first on 
  32.                        Radio Daze AM & FM BBS (219) 256-2255 and
  33.                                 L & L NET National Echo
  34.              
  35.             HNR Documentation                                                   Page 2
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                    TABLE of CONTENTS
  42.                                   -------------------
  43.  
  44.                     General Information............................. 3
  45.  
  46.                     Getting Started................................. 4
  47.  
  48.                     The Main Menu................................... 5
  49.  
  50.                     The News Menu................................... 5
  51.  
  52.                     The Config Menu................................. 7
  53.  
  54.                     The Message Editor.............................. 10
  55.  
  56.                     Registering Headline NewsRoom................... 11
  57.  
  58.  
  59.  
  60. HNR Documentation                                                   Page 3
  61.  
  62.  
  63.           _________________________________________________________________
  64.           _________________________________________________________________
  65.  
  66.                     
  67.           General Information
  68.           _________________________________________________________________
  69.            
  70.           HNR (Headline NewsRoom) was created to fill a gap and allow BBS
  71.           Sysops the ability to easily create professional looking news
  72.           screens to be displayed to users at logon.  I will make the 
  73.           assumption that you the Sysop are familiar with the purpose of 
  74.           the news file in the following documentation.  I hope that this
  75.           program will allow you to easily generate and maintain an
  76.           impressive news display to keep your users informed and take up
  77.           less of your time.  Several programs of this type have come and
  78.           gone and I have tried to take the best features of the myriad
  79.           along with direct input from hard working Sysops to create what
  80.           I hope proves to be a valuable tool.  
  81.     
  82.           Some of HNR's features include;
  83.          
  84.           *  A full screen news message editor with keystrokes/control
  85.              found in popular word processors (line wrap, cursor control,
  86.              etc ..)
  87.  
  88.           *  Allows usage of BBS hostware control codes
  89.  
  90.           *  Up to 64K bytes per message for the Sysop with alot to say
  91.  
  92.           *  Up to 100 active messages 
  93.  
  94.           *  Pull down 'Smart' menus
  95.  
  96.           *  Multiple output styles ; PrinterPaper, NewsPaper, Marquis,
  97.              Banner, DriveIn, ThreeDee and Simple
  98.           
  99.           *  ANSI and ASCII output files with full color control
  100.  
  101.           *  Ability to import text files from disk to be used in the news
  102.              message
  103.  
  104.           *  Headlines and automatic Time/Date stamping to news messages
  105.  
  106.           *  Multi-tasking and DesqView aware
  107.  
  108.           I hope that you enjoy HNR as I know that it will save you
  109.           countless hours when communicating with your callers.
  110.  
  111. HNR Documentation                                                   Page 4
  112.  
  113.  
  114.           _________________________________________________________________
  115.           _________________________________________________________________
  116.  
  117.  
  118.           Getting Started
  119.           _________________________________________________________________
  120.  
  121.        
  122.           To set up HNR you must simply copy HNR.EXE to the directory you 
  123.           want to run it from.  The first time you run HNR it will
  124.           automatically create the support files that it needs to run.
  125.           These files will include HNR.CFG which contains the setup 
  126.           configuration and HNR.DAT which stores the message text used to 
  127.           create the output news screens.  Once you run HNR for the first
  128.           time, you can then call it up from anywhere as long as it resides
  129.           somewhere in your PATH and HNR will find it's support files 
  130.           automatically.
  131.  
  132.           It is recommended that you have ANSI.SYS installed from your 
  133.           CONFIG.SYS file at boot time (the reason for this will be 
  134.           explained later -- see 'View ANSI')
  135.           
  136.           This is all there is to it!  I am from the school of thought that
  137.           believes and operates as follows ...
  138.  
  139.            * UNZIP the thing
  140.            * Find the '.EXE' file 
  141.            * Run it!
  142.            * When all else fails, read the '.DOC's (a really good program
  143.              shouldn't force you to do this step just to run!)
  144.  
  145.           If you are like me then you won't even read this documentation
  146.           unless you run into problems or have got the thing running and 
  147.           wonder if it does anything else that you haven't already discovered.
  148.           
  149.           
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156. HNR Documentation                                                   Page 5
  157.  
  158.  
  159.           _________________________________________________________________
  160.           _________________________________________________________________
  161.  
  162.           The Main Menu
  163.           ═════════════
  164.           1. News
  165.           2. Config
  166.           3. Exit
  167.           _________________________________________________________________
  168.            
  169.           You can use the cursor keys or type the first letter of the item
  170.           to get where you want.  'News' contains the message editor and the
  171.           rebuild and view output files options.  The 'Config' contains user
  172.           customizable setups and configurations.  
  173.           _________________________________________________________________
  174.           _________________________________________________________________
  175.  
  176.  
  177.           The News Menu
  178.           ═════════════
  179.           1. Add New Message  
  180.           2. Edit             
  181.           3. Delete           
  182.           4. Import Text      
  183.           5. Rebuild Output   
  184.           6. View ANSI        
  185.           7. View ASCII       
  186.  
  187.           _________________________________________________________________
  188.           Add New Message:
  189.  
  190.           This option allows you to enter new news messages into your news
  191.           file.  HNR creates a file called HNR.DAT which contains the text
  192.           for each individual news message.  When you select 'Add New Mess-
  193.           age', you will then be prompted to enter a Headline.  You can
  194.           then enter up to a 40 character title to be used for the new
  195.           message.  After entering the Headline you will pop into HNR's
  196.           message editor (see Message Editor) and can enter your message
  197.           text.  
  198.           _________________________________________________________________
  199.           Edit:
  200.  
  201.           This option allows you to edit/change news messages that already
  202.           exist in the HNR NewsRoom file called HNR.DAT.  After selecting
  203.           'Edit' a list of all of the Headlines for all messages currently
  204.           in HNR.DAT will pop up.  You select the message you want to edit
  205.           by cursoring down to the Headline for that message and pressing
  206.           enter when the Headline you want is highlighted.  You can then
  207.           edit the Headline and the message. (see Message Editor)
  208.  
  209. HNR Documentation                                                   Page 6
  210.  
  211.  
  212.           _________________________________________________________________
  213.           Delete:
  214.  
  215.           This option allows you to delete messages from the NewsRoom file.
  216.           Selecting 'Delete' will cause a list of all of the Headlines
  217.           currently in the NewsRoom to pop up.  You can cursor down to the
  218.           Headline that represents the news message you wish to delete.
  219.           After highlighting the Headline, press enter and type 'Y' to
  220.           confirm the delete.  The NewsRoom file will then be updated with
  221.           the unwanted message removed.
  222.           _________________________________________________________________
  223.           Import Text:
  224.  
  225.           This option allows you to read any text file from disk into a 
  226.           NewsRoom message.  After selecting 'Import Text' a box will pop
  227.           up showing all files in the current directory.  The box will also
  228.           contain directories.  You can either highlight and select a file
  229.           or highlight and select a directory to change directories.
  230.  
  231.           This option is especially useful for quoting from a user's
  232.           message, bringing in a document, importing a bulletin, or anything
  233.           that would be a hassle to re-type by hand that already exists
  234.           in a file somewhere on your harddrive.  The HNR NewsRoom has a 
  235.           limit as to the length each line of text can be so in some cases
  236.           where you import a file with long text lines the re-format 
  237.           command in the message editor should be used to clean up the line
  238.           lengths. (see Message Editor)  The file that you import must also
  239.           be less than 64k bytes in size.
  240.           _________________________________________________________________
  241.           Rebuild Output:
  242.  
  243.           This option is the heart of HNR.  It allows you to generate the
  244.           ANSI and ASCII news screens using contents of the current NewsRoom
  245.           message file.  After selecting 'Rebuild Output' choose 'Center'
  246.           or  'Left justify' to determine how text will be formatted in your
  247.           output file.  Your ANSI and ASCII news screens will be re-created 
  248.           in the directory you have selected for output with the current 
  249.           style and colors you have chosen. (see Output Path in Setup)
  250.           _________________________________________________________________
  251.           View ANSI:
  252.  
  253.           This option allows you to view the current ANSI color news screen.
  254.           In order for this option to function correctly you need to be 
  255.           sure you have installed ANSI.SYS in your CONFIG.SYS file. (see 
  256.           your DOS manual)  HNR will look for the filename you have chosen
  257.           for your ANSI screen in the drive/path you have chosen for output.
  258.           You can abort the viewing by pressing the <Esc> key at any time.
  259.           _________________________________________________________________
  260.           View ASCII:
  261.  
  262.           This option allows you to view the current ASCII news screen.
  263.           The ASCII screen contains no colors and is the 'monochrome' 
  264.           news screen.  HNR will look for the filename you have chosen
  265.           for your ASCII screen in the drive/path you have chosen for output.
  266.           You can abort the viewing by pressing the <Esc> key at any time.
  267. HNR Documentation                                                   Page 7
  268.  
  269.  
  270.           _________________________________________________________________
  271.           _________________________________________________________________
  272.  
  273.  
  274.           The Config Menu
  275.           ═══════════════
  276.           1. Output Style
  277.           2. Setup
  278.           3. ANSI Colors
  279.           4. Register <see Registering Headline NewsRoom on page 10>
  280.  
  281.           The 'Config Menu' allows you to customize HNR.  The configuration
  282.           information is stored in a file called HNR.CNF.
  283.           _________________________________________________________________
  284.           Output Style:
  285.  
  286.           This option allows you to select the style used when rebuilding
  287.           the output news files.  Seven different output styles are 
  288.           available to the user.
  289.            
  290.           * PrinterPaper
  291.           * Marquis  
  292.           * NewsPaper
  293.           * Banner   
  294.           * DriveIn  
  295.           * ThreeDee 
  296.           * Simple   
  297. HNR Documentation                                                   Page 8
  298.  
  299.           _________________________________________________________________
  300.           Setup:
  301.  
  302.           Selecting 'Setup' will display the following data entry box;
  303.           
  304.           ╒═════════════════ SetUp - <Esc> when done ═════════════════╕           
  305.           │                                                           │           
  306.           │        BBS Name: Radio Daze AM & FM BBS                   │           
  307.           │      Sysop Name: Michael Shannon                          │           
  308.           │     Output Path: C:\PROJ\PAS\                             │           
  309.           │  ANSI File Name: HNR.ANS                                  │           
  310.           │ ASCII File Name: HNR.ASC                                  │           
  311.           │    Initial Code: 111                                      │           
  312.           │  Control Code 1: 222                                      │           
  313.           │  Control Code 2: 333                                      │           
  314.           │  Control Code 3: 444                                      │           
  315.           │ Refer to your BBS hostware manual for the definition of   │           
  316.           │ the control codes that will work with your software.      │           
  317.           │                            Current Style = THREEDEE       │           
  318.           ╘═══════════════════════════════════════════════════════════╛           
  319.  
  320.           * BBS Name: Enter the name of your BBS
  321.           * Sysop Name: Enter your name
  322.           * Output Path: Enter the full drive:\path where your BBS 
  323.             software expects to find the necessary news display files.
  324.           * ANSI File Name: Enter the filename that your BBS software 
  325.             uses for the color news file.
  326.           * ASCII File Name: Enter the filename that your BBS software
  327.             uses for the mono news file.
  328.           * Initial Code: You may enter a control code to be inserted at
  329.             the very beginning of your news display files.  See your 
  330.             BBS software manual for a list of the codes that you can use.
  331.           * Control Codes 1-3: You may enter up to 3 control codes to be
  332.             inserted in between each news message in the display files.
  333.  
  334.           The current output style is also displayed for your information.
  335.           Once you have entered all of the information you can press
  336.           the escape key to leave 'Setup'.  When you leave 'Setup', the
  337.           configuration file HNR.CNF is automatically updated with the
  338.           new setup information.
  339.  
  340.           The ability to insert control codes is a new feature.  A Wildcat
  341.           Sysop, for example, could add @PAUSE@ and @CLS@ to pause, then
  342.           clear the screen after each news message.
  343. HNR Documentation                                                   Page 9
  344.  
  345.  
  346.           _________________________________________________________________
  347.           ANSI Colors:
  348.  
  349.           This option allows you to customize the colors used in the ANSI
  350.           news file.  You may select the colors used for ...
  351.  
  352.           * The Border Color   
  353.           * The Sysop/BBS Lines
  354.           * The Date/Time Line 
  355.           * The Headline       
  356.           * The first alternating message line color
  357.           * The second alternating message line color
  358.  
  359.           Once you have selected which color you wish to change, a box
  360.           will pop up allowing you to select from the color palette
  361.           with the cursor and enter keys.  Say you have selected 'Border
  362.           Color', you would see ...
  363.  
  364.          ╔═════════════════════ Select Border Color ══════════════════════╗
  365.          ║■■■■■■■■■■■■■■■■                                                ║
  366.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  367.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  368.          ║■■■■ The ■■■■■■■    ***        BBS/Sysop Name Here        ***   ║
  369.          ║■■■■ Color ■■■■■    ***     10/12/1991 at 12:01:01 am     ***   ║
  370.          ║■■■■ Palette ■■■    ***   ╔════════════════════════════╗  ***   ║
  371.          ║■■■■■■■■■■■■■■■■    ***   ║  Headline News Extra !!!   ║  ***   ║
  372.          ║■■■■■■■■■■■■■■■■    ***   ╚════════════════════════════╝  ***   ║
  373.          ║■■■■■■■■■■■■■■■■    ***    This is the first text line    ***   ║
  374.          ║■■■■■■■■■■■■■■■■    ***      This is the second line      ***   ║
  375.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  376.          ║■■■■■■■■■■■■■■■■    *****************************************   ║
  377.          ║■■■■■■■■■■■■■■■■                                                ║
  378.          ║■■■■■■■■■■■■■■■■  <═══                                          ║
  379.          ║■■■■■■■■■■■■■■■■    Use the cursor keys to move to the          ║
  380.          ║■■■■■■■■■■■■■■■■    color you want, Press <Enter> to select     ║
  381.          ╚════════════════════════════════════════════════════════════════╝
  382.  
  383.           At this point you can use the cursor keys to move around the 
  384.           palette and watch the example output screen update as you move.
  385.           When you have found the color you wish to use press enter to 
  386.           select it.  If you press escape with out pressing enter, the 
  387.           color will not change from what it was previously.
  388.  
  389.  
  390. HNR Documentation                                                   Page 10
  391.  
  392.  
  393.           _________________________________________________________________
  394.           _________________________________________________________________
  395.  
  396.                     
  397.           The Message Editor 
  398.           _________________________________________________________________
  399.  
  400.           The message editor uses many keystrokes found in popular word
  401.           processors.  The following commands are available ...
  402.  
  403.           <The Ctrl-Key is shown using "^">
  404.  
  405.           ^-Key or Key Combination  =  Effect                 
  406.           ═════    ═══════════════     ══════                 
  407.           ^A       ^Left              Cursor word left       
  408.           ^C       PgDn               Page down              
  409.           ^D       Right              Cursor right           
  410.           ^E       Up                 Cursor up              
  411.           ^F       ^Right             Cursor word right      
  412.           ^G       Del                Delete character       
  413.           ^I       Tab                Tab right              
  414.           ^M       Enter              New line               
  415.           ^S       Left               Cursor left            
  416.           ^X       Down               Cursor down one line   
  417.           ^R       PgUp               Page up                
  418.           ^M       Enter              Start new line         
  419.           ^QD      End                Cursor to end of line     
  420.           ^QS      Home               Cursor to start of line   
  421.           ^QE      ^Home              Cursor to top of window   
  422.           ^QX      ^End               Cursor to bottom of window
  423.           ^QR      ^PgUp              Cursor to start of message
  424.           ^QC      ^PgDn              Cursor to end of message  
  425.                                                                 
  426.           Keys = Effect                    Keys = Effect        
  427.           ═════  ══════                    ═════  ══════        
  428.           ^B     Reformat paragraph        ^OI    Toggle auto-indent    
  429.           ^W     Scroll up one line        ^P[^?] Insert Ctrl char [^?] 
  430.           ^Z     Scroll down one line      Alt-R  Reformat entire message
  431.           ^Y     Delete current line       ^T     Delete word right     
  432.           <F2>   Save message              ^QL    Undo                  
  433.           ^QY    Delete to end of line     ^OW    Toggle word wrap      
  434.           Esc    Quit editor                                            
  435.         
  436.  
  437.  
  438. HNR Documentation                                                   Page 11
  439.  
  440.  
  441.           _________________________________________________________________
  442.           _________________________________________________________________
  443.  
  444.  
  445.           Registering Headline NewsRoom
  446.           ═════════════════════════════
  447.  
  448.           If you find yourself using Headline NewsRoom on a regular basis,
  449.           you must register your copy.  Headline NewsRoom can be registered
  450.           by filling out the registration form included in HNRREG.DOC and
  451.           sending it along with $10.00 US to ...
  452.  
  453.           Scott Null
  454.           Oakwood Software / Microdyne ONLINE
  455.           306 West 8th Street
  456.           Mishawaka, IN  46544
  457.  
  458.           [Make checks payable to Scott Null]
  459.  
  460.           Or register by sending only $5.00 US and proof of membership to
  461.           Radio Daze AM & FM BBS. (Home of Headline NewsRoom)
  462.           In order to qualify for the reduced rate you must be a PAID
  463.           subscriber to Radio Daze AM & FM BBS.
  464.  
  465.           Registered users will receive a personal registration number.
  466.           This number can then be entered into the 'Register' option
  467.           under the 'Config' menu.  This number will eliminate the 
  468.           appearance of "**UNREGISTERED**" in the output news files.
  469.           Registered users will also be automatically registered for
  470.           future versions of Headline NewsRoom.  Registered users will
  471.           receive free/unlimited on-line techical support via Radio Daze 
  472.           AM & FM BBS or any BBS that carries the (L&L Net) Oakwood
  473.           Software conference.
  474.  
  475.           Registered users will also receive that good feeling associated 
  476.           with supporting shareware development. 
  477.           <Remember - Shareware keeps BBSs in business too!>
  478.  
  479.           Also remember to call Radio Daze AM & FM BBS at (219) 256-2255
  480.            * Multi-Node 12/24/96/19.2
  481.            * 1.75 Gig -- thousands and thousands of files!
  482.            * World wide Echos and Conferences
  483.            * Forums / SIGs / Doors / ONLINE store and more!
  484.            * HNR Online Technical support for registered users
  485.           
  486.           _________________________________________________________________
  487.  
  488.  
  489.